home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.2 Development Libraries / SGI IRIX 6.2 Development Libraries.iso / dist / complib.idb / usr / share / catman / p_man / cat3 / complib / cgebd2.z / cgebd2
Text File  |  1996-03-14  |  6KB  |  199 lines
  1.  
  2.  
  3.  
  4. CCCCGGGGEEEEBBBBDDDD2222((((3333FFFF))))                                                          CCCCGGGGEEEEBBBBDDDD2222((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CGEBD2 - reduce a complex general m by n matrix A to upper or lower real
  10.      bidiagonal form B by a unitary transformation
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE CGEBD2( M, N, A, LDA, D, E, TAUQ, TAUP, WORK, INFO )
  14.  
  15.          INTEGER        INFO, LDA, M, N
  16.  
  17.          REAL           D( * ), E( * )
  18.  
  19.          COMPLEX        A( LDA, * ), TAUP( * ), TAUQ( * ), WORK( * )
  20.  
  21. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  22.      CGEBD2 reduces a complex general m by n matrix A to upper or lower real
  23.      bidiagonal form B by a unitary transformation: Q' * A * P = B.
  24.  
  25.      If m >= n, B is upper bidiagonal; if m < n, B is lower bidiagonal.
  26.  
  27.  
  28. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  29.      M       (input) INTEGER
  30.              The number of rows in the matrix A.  M >= 0.
  31.  
  32.      N       (input) INTEGER
  33.              The number of columns in the matrix A.  N >= 0.
  34.  
  35.      A       (input/output) COMPLEX array, dimension (LDA,N)
  36.              On entry, the m by n general matrix to be reduced.  On exit, if m
  37.              >= n, the diagonal and the first superdiagonal are overwritten
  38.              with the upper bidiagonal matrix B; the elements below the
  39.              diagonal, with the array TAUQ, represent the unitary matrix Q as
  40.              a product of elementary reflectors, and the elements above the
  41.              first superdiagonal, with the array TAUP, represent the unitary
  42.              matrix P as a product of elementary reflectors; if m < n, the
  43.              diagonal and the first subdiagonal are overwritten with the lower
  44.              bidiagonal matrix B; the elements below the first subdiagonal,
  45.              with the array TAUQ, represent the unitary matrix Q as a product
  46.              of elementary reflectors, and the elements above the diagonal,
  47.              with the array TAUP, represent the unitary matrix P as a product
  48.              of elementary reflectors.  See Further Details.  LDA     (input)
  49.              INTEGER The leading dimension of the array A.  LDA >= max(1,M).
  50.  
  51.      D       (output) REAL array, dimension (min(M,N))
  52.              The diagonal elements of the bidiagonal matrix B:  D(i) = A(i,i).
  53.  
  54.      E       (output) REAL array, dimension (min(M,N)-1)
  55.              The off-diagonal elements of the bidiagonal matrix B:  if m >= n,
  56.              E(i) = A(i,i+1) for i = 1,2,...,n-1; if m < n, E(i) = A(i+1,i)
  57.              for i = 1,2,...,m-1.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCGGGGEEEEBBBBDDDD2222((((3333FFFF))))                                                          CCCCGGGGEEEEBBBBDDDD2222((((3333FFFF))))
  71.  
  72.  
  73.  
  74.      TAUQ    (output) COMPLEX array dimension (min(M,N))
  75.              The scalar factors of the elementary reflectors which represent
  76.              the unitary matrix Q. See Further Details.  TAUP    (output)
  77.              COMPLEX array, dimension (min(M,N)) The scalar factors of the
  78.              elementary reflectors which represent the unitary matrix P. See
  79.              Further Details.  WORK    (workspace) COMPLEX array, dimension
  80.              (max(M,N))
  81.  
  82.      INFO    (output) INTEGER
  83.              = 0: successful exit
  84.              < 0: if INFO = -i, the i-th argument had an illegal value.
  85.  
  86. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  87.      The matrices Q and P are represented as products of elementary
  88.      reflectors:
  89.  
  90.      If m >= n,
  91.  
  92.         Q = H(1) H(2) . . . H(n)  and  P = G(1) G(2) . . . G(n-1)
  93.  
  94.      Each H(i) and G(i) has the form:
  95.  
  96.         H(i) = I - tauq * v * v'  and G(i) = I - taup * u * u'
  97.  
  98.      where tauq and taup are complex scalars, and v and u are complex vectors;
  99.      v(1:i-1) = 0, v(i) = 1, and v(i+1:m) is stored on exit in A(i+1:m,i);
  100.      u(1:i) = 0, u(i+1) = 1, and u(i+2:n) is stored on exit in A(i,i+2:n);
  101.      tauq is stored in TAUQ(i) and taup in TAUP(i).
  102.  
  103.      If m < n,
  104.  
  105.         Q = H(1) H(2) . . . H(m-1)  and  P = G(1) G(2) . . . G(m)
  106.  
  107.      Each H(i) and G(i) has the form:
  108.  
  109.         H(i) = I - tauq * v * v'  and G(i) = I - taup * u * u'
  110.  
  111.      where tauq and taup are complex scalars, v and u are complex vectors;
  112.      v(1:i) = 0, v(i+1) = 1, and v(i+2:m) is stored on exit in A(i+2:m,i);
  113.      u(1:i-1) = 0, u(i) = 1, and u(i+1:n) is stored on exit in A(i,i+1:n);
  114.      tauq is stored in TAUQ(i) and taup in TAUP(i).
  115.  
  116.      The contents of A on exit are illustrated by the following examples:
  117.  
  118.      m = 6 and n = 5 (m > n):          m = 5 and n = 6 (m < n):
  119.  
  120.        (  d   e   u1  u1  u1 )           (  d   u1  u1  u1  u1  u1 )
  121.        (  v1  d   e   u2  u2 )           (  e   d   u2  u2  u2  u2 )
  122.        (  v1  v2  d   e   u3 )           (  v1  e   d   u3  u3  u3 )
  123.        (  v1  v2  v3  d   e  )           (  v1  v2  e   d   u4  u4 )
  124.        (  v1  v2  v3  v4  d  )           (  v1  v2  v3  e   d   u5 )
  125.        (  v1  v2  v3  v4  v5 )
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCGGGGEEEEBBBBDDDD2222((((3333FFFF))))                                                          CCCCGGGGEEEEBBBBDDDD2222((((3333FFFF))))
  137.  
  138.  
  139.  
  140.      where d and e denote diagonal and off-diagonal elements of B, vi denotes
  141.      an element of the vector defining H(i), and ui an element of the vector
  142.      defining G(i).
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.